docs: replace template README with CV repo overview - #76
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ea41fd8094
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## Deployment | ||
|
|
||
| If you have docker installed you can simply run `docker-compose up` to launch the site in a container, it will then be hosted at `http://localhost:4000` | ||
| Hosted on Vercel. Merging to `master` triggers a production deployment; PR branches get preview deployments. |
There was a problem hiding this comment.
Use
main in the deployment instructions
The repository's active base branch is main (refs/heads/main points at this commit's parent), and there is no master ref. As written, maintainers following this deployment guidance would target a nonexistent branch rather than the branch used by the repository, so the documented production-deployment flow cannot work; update this to name main (or the actual Vercel production branch if it is configured differently).
Useful? React with 👍 / 👎.
Replaces the sproogen modern-resume-theme template README (which still points at the theme author's email, buy-me-a-coffee link and GitHub Pages setup) with a short overview of this repo: what it is, content structure, local dev and Vercel deployment.
No content or config changes.